All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.AbstractButton

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.AbstractButton

public abstract class AbstractButton

extends JComponent

implements ItemSelectable, SwingConstants

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

actionListener

BORDER_PAINTED_CHANGED_PROPERTY

changeEvent

Only one ChangeEvent is needed per button instance since the event's only state is the source property.

changeListener

The button's model listeners.

DISABLED_ICON_CHANGED_PROPERTY

DISABLED_SELECTED_ICON_CHANGED_PROPERTY

FOCUS_PAINTED_CHANGED_PROPERTY

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY

ICON_CHANGED_PROPERTY

itemListener

MARGIN_CHANGED_PROPERTY

MNEMONIC_CHANGED_PROPERTY

model

MODEL_CHANGED_PROPERTY

PRESSED_ICON_CHANGED_PROPERTY

ROLLOVER_ENABLED_CHANGED_PROPERTY

ROLLOVER_ICON_CHANGED_PROPERTY

ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY

SELECTED_ICON_CHANGED_PROPERTY

TEXT_CHANGED_PROPERTY

VERTICAL_ALIGNMENT_CHANGED_PROPERTY

VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

AbstractButton()

addActionListener(ActionListener)

adds an ActionListener to the button

addChangeListener(ChangeListener)

Adds a ChangeListener to the button.

addItemListener(ItemListener)

adds an ItemListener to the checkbox

checkHorizontalKey(int, String)

Ensures that the key is a valid.

checkVerticalKey(int, String)

Ensures that the key is a valid.

createActionListener()

createChangeListener()

Subclasses that want to handle ChangeEvents differently can override this to return another ChangeListener implementation.

createItemListener()

doClick()

Programatically perform a "click".

doClick(int)

Programatically perform a "click".

fireActionPerformed(ActionEvent)

fireItemStateChanged(ItemEvent)

fireStateChanged()

getActionCommand()

Returns the action command for this button.

getDisabledIcon()

Returns the icon used by the button when it's disabled.

getDisabledSelectedIcon()

Returns the icon used by the button when it's disabled and selected.

getHorizontalAlignment()

Returns the horizontal alignment of the icon and text.

getHorizontalTextPosition()

Sets the horizontal position of the text relative to the icon.

getIcon()

Returns the default icon.

getLabel()

Deprecated.

getMargin()

Returns the margin between the button's border and the label.

getMnemonic()

Get the keyboard mnemonic from the the current model

getModel()

Get the model that this button represents.

getPressedIcon()

Returns the pressed icon for the button.

getRolloverIcon()

Returns the rollover icon for the button.

getRolloverSelectedIcon()

Returns the rollover seletion icon for the button.

getSelectedIcon()

Returns the selected icon for the button.

getSelectedObjects()

getText()

Returns the button's text.

getUI()

Returns the button's current UI.

getVerticalAlignment()

Returns the vertical alignment of the text and icon.

getVerticalTextPosition()

Returns the vertical position of the text relative to the icon Valid keys: CENTER (the default), TOP, BOTTOM

init(String, Icon)

isBorderPainted()

Returns whether the border should be painted.

isFocusPainted()

Returns whether focus should be painted.

isRolloverEnabled()

Checks whether rollover effects are enabled.

isSelected()

Returns the state of the button.

paintBorder(Graphics)

Paint the button's border if BorderPainted property is true.

removeActionListener(ActionListener)

removes an ActionListener from the button

removeChangeListener(ChangeListener)

Removes a ChangeListener from the button.

removeItemListener(ItemListener)

removes an ItemListener from the button

setActionCommand(String)

Sets the action command for this button.

setBorderPainted(boolean)

Sets whether the border should be painted.

setDisabledIcon(Icon)

Sets the disabled icon for the button.

setDisabledSelectedIcon(Icon)

Sets the disabled selection icon for the button.

setEnabled(boolean)

Enables (or disables) the button.

setFocusPainted(boolean)

Sets whether focus should be painted.

setHorizontalAlignment(int)

Sets the horizontal alignment of the icon and text.

setHorizontalTextPosition(int)

Sets the horizontal position of the text relative to the icon.

setIcon(Icon)

Sets the button's default icon.

setLabel(String)

Deprecated.

setMargin(Insets)

Sets space for margin between the button's border and the label.

setMnemonic(char)

setMnemonic(int)

Set the keyboard mnemonic on the current model

setModel(ButtonModel)

Set the model that this button represents.

setPressedIcon(Icon)

Sets the pressed icon for the button.

setRolloverEnabled(boolean)

Sets whether rollover effects should be enabled.

setRolloverIcon(Icon)

Sets the rollover icon for the button.

setRolloverSelectedIcon(Icon)

Sets the rollover selected icon for the button.

setSelected(boolean)

Sets the state of the button.

setSelectedIcon(Icon)

Sets the selected icon for the button.

setText(String)

Sets the button's text.

setUI(ButtonUI)

Sets the button's UI.

setVerticalAlignment(int)

Sets the vertical alignment of the icon and text.

setVerticalTextPosition(int)

Sets the vertical position of the text relative to the icon.

updateUI()

Gets a new UI object from the default UIFactory.

 public static final String MODEL_CHANGED_PROPERTY

 public static final String TEXT_CHANGED_PROPERTY

 public static final String MNEMONIC_CHANGED_PROPERTY

 public static final String MARGIN_CHANGED_PROPERTY

 public static final String VERTICAL_ALIGNMENT_CHANGED_PROPERTY

 public static final String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

 public static final String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

 public static final String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY

 public static final String BORDER_PAINTED_CHANGED_PROPERTY

 public static final String FOCUS_PAINTED_CHANGED_PROPERTY

 public static final String ROLLOVER_ENABLED_CHANGED_PROPERTY

 public static final String ICON_CHANGED_PROPERTY

 public static final String PRESSED_ICON_CHANGED_PROPERTY

 public static final String SELECTED_ICON_CHANGED_PROPERTY

 public static final String ROLLOVER_ICON_CHANGED_PROPERTY

 public static final String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY

 public static final String DISABLED_ICON_CHANGED_PROPERTY

 public static final String DISABLED_SELECTED_ICON_CHANGED_PROPERTY

 protected ButtonModel model

 protected ChangeListener changeListener

The button's model listeners.

 protected ActionListener actionListener

 protected ItemListener itemListener

 protected transient ChangeEvent changeEvent

Only one ChangeEvent is needed per button instance since the event's only state is the source property. The source of events generated is always "this".

 public AbstractButton()

 public String getText()

Returns the button's text.

See Also:

setText

 public void setText(String text)

Sets the button's text.

Parameters:

t - the string used to set the text

See Also:

getText

 public boolean isSelected()

Returns the state of the button. True if the toggle button is selected, false if it's not.

 public void setSelected(boolean b)

Sets the state of the button.

 public void doClick()

Programatically perform a "click". This does the same thing as if the user had pressed and released the button.

 public void doClick(int pressTime)

Programatically perform a "click". This does the same thing as if the user had pressed and released the button. The button stays visually "pressed" for pressTime milliseconds.

 public void setMargin(Insets m)

Sets space for margin between the button's border and the label. Setting to null will cause the button to use the default margin. The button's default Border object will use this value to create the proper margin. However, if a non-default border is set on the button, it is that Border object's responsibility to create the appropriate margin space (else this property will effectively be ignored).

Parameters:

m - the space between the border and the label

 public Insets getMargin()

Returns the margin between the button's border and the label.

 public Icon getIcon()

Returns the default icon.

See Also:

setIcon

 public void setIcon(Icon defaultIcon)

Sets the button's default icon. This icon is also used as the "pressed" and "disabled" icon if there is no explicitly set pressed icon.

Parameters:

g - the icon used as the default image

See Also:

getIcon, setPressedIcon

 public Icon getPressedIcon()

Returns the pressed icon for the button.

See Also:

setPressedIcon

 public void setPressedIcon(Icon pressedIcon)

Sets the pressed icon for the button.

Parameters:

g - the icon used as the "pressed" image

See Also:

getPressedIcon

 public Icon getSelectedIcon()

Returns the selected icon for the button.

See Also:

setSelectedIcon

 public void setSelectedIcon(Icon selectedIcon)

Sets the selected icon for the button.

Parameters:

g - the icon used as the "selected" image

See Also:

getSelectedIcon

 public Icon getRolloverIcon()

Returns the rollover icon for the button.

See Also:

setRolloverIcon

 public void setRolloverIcon(Icon rolloverIcon)

Sets the rollover icon for the button.

Parameters:

g - the icon used as the "rollover" image

See Also:

getRolloverIcon

 public Icon getRolloverSelectedIcon()

Returns the rollover seletion icon for the button.

See Also:

setRolloverSelectedIcon

 public void setRolloverSelectedIcon(Icon rolloverSelectedIcon)

Sets the rollover selected icon for the button.

Parameters:

g - the icon used as the "selected rollover" image

See Also:

getRolloverSelectedIcon

 public Icon getDisabledIcon()

Returns the icon used by the button when it's disabled. If not no disabled icon has been set, the button constructs one from the default icon. PENDING(jeff): the disabled icon really should be created (if necesary) by the L&F.

See Also:

getPressedIcon, setDisabledIcon

 public void setDisabledIcon(Icon disabledIcon)

Sets the disabled icon for the button.

Parameters:

g - the icon used as the disabled image

See Also:

getDisabledIcon

 public Icon getDisabledSelectedIcon()

Returns the icon used by the button when it's disabled and selected. If not no disabled selection icon has been set, the button constructs one from the selection icon. PENDING(jeff): the disabled selection icon really should be created (if necesary) by the L&F.

See Also:

getPressedIcon, setDisabledIcon

 public void setDisabledSelectedIcon(Icon disabledSelectedIcon)

Sets the disabled selection icon for the button.

Parameters:

g - the icon used as the disabled selection image

See Also:

getDisabledSelectedIcon

 public int getVerticalAlignment()

Returns the vertical alignment of the text and icon. Valid keys: CENTER (the default), TOP, BOTTOM

 public void setVerticalAlignment(int alignment)

Sets the vertical alignment of the icon and text. Valid keys: CENTER (the default), TOP, BOTTOM

 public int getHorizontalAlignment()

Returns the horizontal alignment of the icon and text. Valid keys: CENTER (the default), LEFT, RIGHT

 public void setHorizontalAlignment(int alignment)

Sets the horizontal alignment of the icon and text. Valid keys: CENTER (the default), LEFT, RIGHT

 public int getVerticalTextPosition()

Returns the vertical position of the text relative to the icon Valid keys: CENTER (the default), TOP, BOTTOM

 public void setVerticalTextPosition(int textPosition)

Sets the vertical position of the text relative to the icon. Valid keys: CENTER (the default), TOP, BOTTOM

 public int getHorizontalTextPosition()

Sets the horizontal position of the text relative to the icon. Valid keys: RIGHT (the default), LEFT, CENTER

 public void setHorizontalTextPosition(int textPosition)

Sets the horizontal position of the text relative to the icon. Valid keys: RIGHT (the default), LEFT, CENTER

 protected int checkHorizontalKey(int key,
                                  String exception)

Ensures that the key is a valid. Throws an IllegalArgument exception exception otherwise.

 protected int checkVerticalKey(int key,
                                String exception)

Ensures that the key is a valid. Throws an IllegalArgument exception exception otherwise.

 public void setActionCommand(String actionCommand)

Sets the action command for this button.

 public String getActionCommand()

Returns the action command for this button.

 public boolean isBorderPainted()

Returns whether the border should be painted.

See Also:

setBorderPainted

 public void setBorderPainted(boolean b)

Sets whether the border should be painted.

Parameters:

b - if true and border property is not null, the border is painted.

See Also:

isBorderPainted

 protected void paintBorder(Graphics g)

Paint the button's border if BorderPainted property is true.

Overrides:

paintBorder in class JComponent

See Also:

paint, setBorder

 public boolean isFocusPainted()

Returns whether focus should be painted.

See Also:

setFocusPainted

 public void setFocusPainted(boolean b)

Sets whether focus should be painted.

Parameters:

b - if true, the focus state is painted.

See Also:

isFocusPainted

 public boolean isRolloverEnabled()

Checks whether rollover effects are enabled.

See Also:

setFocusPainted

 public void setRolloverEnabled(boolean b)

Sets whether rollover effects should be enabled.

Parameters:

b - if true, rollover effects should be painted.

See Also:

isRolloverEnabled

 public int getMnemonic()

Get the keyboard mnemonic from the the current model

 public void setMnemonic(int mnemonic)

Set the keyboard mnemonic on the current model

Parameters:

mnemonic - the key code which represents the mnemonic

 public void setMnemonic(char mnemonic)

 public ButtonModel getModel()

Get the model that this button represents.

See Also:

setModel

 public void setModel(ButtonModel newModel)

Set the model that this button represents.

Parameters:

m - the Model

See Also:

getModel

 public ButtonUI getUI()

Returns the button's current UI.

See Also:

setUI

 public void setUI(ButtonUI ui)

Sets the button's UI.

Parameters:

ui - the new ButtonUI

See Also:

getUI

 public void updateUI()

Gets a new UI object from the default UIFactory. Subtypes of AbstractButton should override this to update the UI. For example, JButton might do the following: setUI((ButtonUI)UIManager.getUI( "ButtonUI", "com.sun.java.swing.plaf.basic.BasicButtonUI", this));

Overrides:

updateUI in class JComponent

 public void addChangeListener(ChangeListener l)

Adds a ChangeListener to the button.

 public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the button.

 protected void fireStateChanged()

 public void addActionListener(ActionListener l)

adds an ActionListener to the button

 public void removeActionListener(ActionListener l)

removes an ActionListener from the button

 protected ChangeListener createChangeListener()

Subclasses that want to handle ChangeEvents differently can override this to return another ChangeListener implementation.

 protected void fireActionPerformed(ActionEvent event)

 protected void fireItemStateChanged(ItemEvent event)

 protected ActionListener createActionListener()

 protected ItemListener createItemListener()

 public void setEnabled(boolean b)

Enables (or disables) the button.

Overrides:

setEnabled in class Component

 public String getLabel()

Note: getLabel() is deprecated. - Replaced by getText()

 public void setLabel(String label)

Note: setLabel() is deprecated. - Replaced by setText(text)

 public void addItemListener(ItemListener l)

adds an ItemListener to the checkbox

 public void removeItemListener(ItemListener l)

removes an ItemListener from the button

 public Object[] getSelectedObjects()

 protected void init(String text,
                     Icon icon)

All Packages  Class Hierarchy  This Package  Previous  Next  Index